Skip to content

Conversation

@TNick
Copy link
Contributor

@TNick TNick commented Jun 10, 2015

This is based on @lamblin 's answer here

Would it be possible to rethink the structure of the documentation?

   overview
   vision
   features
   faq
   tutorials/index
   advanced/index
   LICENSE
   library/index
   internal/index

Advanced topics:

   index
   cluster
   large_data

Tutorials

   index
   theano_to_pylearn2_tutorial
   tutorial/with_jobman
   yaml_tutorial/index
   tutorial/notebook_tutorials
   predicting

Move to internal:

   internal/metadocumentation
   internal/data_specs
   internal/pull_request_checklist
   internal/api_coding_style
   api_change

Or something along those lines?

@lamblin
Copy link
Member

lamblin commented Jun 16, 2015

Thanks a lot! Apart from these nitpicking comments, I'm ready to merge.
Your re-organization of the documentation also makes a lot of sense. I would maybe rename "internal" for "developer", and keep LICENSE at the end, but otherwise it makes sense.
Ideally, we would have URLs reflecting the new hierarchy, but keep redirections from the older URLs for some time, if there is an easy way to do so with sphinx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants